home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Reference Guide / C-C++ Interactive Reference Guide.iso / c_ref / csource3 / 144_01 / toolkit.hlp < prev    next >
Text File  |  1985-08-21  |  7KB  |  152 lines
  1. **********************************************************************
  2. *                      VAN NUYS BRIDGE TOOLKIT                       *
  3. **********************************************************************
  4. *                  COPYRIGHT 1983 EUGENE H. MALLORY                  *
  5. **********************************************************************
  6.     
  7.     The Van Nuys Bridge Toolkit is a collection of text processing 
  8.     tools, operating on CP/M 2.2, which are similar to the type of 
  9.     tools generally provided in UNIX.  They can be used to shape or 
  10.     change text for a great number of purposes. 
  11.     
  12.     Most of the tools have two inputs and an output.  One input is 
  13.     the command line itself.  That generally provides any options or 
  14.     arguments as well as providing specifications for the standard 
  15.     input and standard output stream.  Without any specification for 
  16.     the standard I/O, input is from the console and output is to the 
  17.     console. Input from the console uses a "*" prompt.
  18.     
  19.     Input may be redirected by specifying a file name with the format:
  20.     
  21.     A>TOOL <filename
  22.     
  23.     The default output is to the console screen.  Output may be 
  24.     redirected to a file, to a printer or to both the screen and a 
  25.     file.  
  26.  
  27.     Redirection can take the following forms:
  28.     
  29.         > fid    Output redirection to file
  30.         < fid    Input rediredtion from file
  31.         + fid    Output redirection to file and screen
  32.         ~ fid    Output redirection to file and printer
  33.         >> fid    Append to file
  34.         +> fid    Append to file and output to screen
  35.         ~> fid    Append to file and output to printer
  36.         > LST:    Output to LST device
  37.         >> LST:    As above
  38.         + LST:    Output to LST device and screen
  39.         > LP1:    Output to LP1 (IOBYTE = 0x80)
  40.         >> LP1:    As above
  41.         + LP1:    As above and to screen
  42.         > LP2:    Output to LP2 (IOBYTE = 0xC0)
  43.         >> LP2:    As above
  44.         + LP2:    As above and to screen
  45.         > OUT:    Output to PUNCH DEVICE
  46.         >> OUT:    As above
  47.         + OUT:    As above and to screen
  48.         ~ OUT:    As above and to printer
  49.         < IN:    Input from READER device
  50.         
  51.         | prog    Pipe output to next program
  52.         +| prog    As above and to screen
  53.         ~| prog    As above and to printer
  54.     
  55.     Redirection and pipe character may be separated from
  56.     the file or program name by white space or not.
  57.     
  58.     File specifications may be complete with user number (##) and 
  59.     disk name (d) in the form:
  60.     
  61.             ##/d:name
  62.     
  63.     Pipe specification will be first tried as is, if the file 
  64.     does not exist, disk A, user 0 will be tried using the same 
  65.     name.
  66.     
  67.     Control C will abort program and submit file execution.
  68.     When inputing from keyboard use Control C except at    
  69.     column 1. (CP/M catches it there.)  If an old version of
  70.     the output file existed, it will be recovered by Control C.
  71.     
  72.     It is permissable to input and output from the same file,  
  73.     BUT the input specification must be first and the output
  74.     specification must be second!  otherwise the order and 
  75.     location of the redirection specifications is not
  76.     significant.
  77.     
  78.     A number of the tools use ambiguous file names or wildcards to 
  79.     identify a list of file names.  The format is the same for all 
  80.     tools.  The ambiguous file name characters are a superset of 
  81.     those used by CP/M DIR.  * means any number of any character, ? 
  82.     means exactly one of any character.  Unlike DIR, a list of 
  83.     ambiguous file names may be used.  Also, if an ambiguous file 
  84.     name is preceded by a !, files matching that specification will 
  85.     be EXCLUDED from the list.  See LS to get more information.
  86.     
  87.     These tools have some limitations.  They are able to only handle 
  88.     normal CP/M text files.  Files must have these characteristics:
  89.     
  90.     1)  They must not be null or totally empty.
  91.     
  92.     2)  They must have a CR LF pair at the end of each line
  93.         including the last line.
  94.     
  95.     3)  Lines more than 132 characters will cause the programs
  96.         to blow up.
  97.     
  98.     4)  Both kinds of CP/M eof conditions are handled well.
  99.     
  100.     5)  Some of the tools will behave badly if they get text
  101.         with CR's, backspaces and other control characters
  102.         in the text.  This is noted in the individual HELP files.
  103.     
  104.     6)  The output file must be on the current logged on disk.
  105.         Specification of another disk will be ignored and
  106.         the output will end up on the current disk anyway.
  107.         (Final output file is created by REN of a temp file.)
  108.     
  109.     7)  Input files and tools may be on other disks.  Tools
  110.         are searched for on the current disk first, and on 
  111.         disk A: second if no specification is made.  It is
  112.         handy to put the tools all on disk A: and work on 
  113.         another disk. 
  114.  
  115.     CLEAN may be able to clean up many files with these problems.
  116.     
  117.     Error messages are prefixed by the tool name which generates the
  118.     message.  An exception is when an error is made in the input or
  119.     output redirection or in the pipe specification.  In these cases,
  120.     the message is prefixed with the name DIO: for Directed IO.
  121.     
  122.     Note that where tools have "-" options such as -U, the options 
  123.     may be run together so that 2UP -N4M10S2 is the same as -N4 -M10 
  124.     -S2.  The redirection specification and "-" options may be in any 
  125.     order on the command line.  They are processed and removed before 
  126.     the parameters, if any, are passed to the tool.  Thus SUB <A ABC 
  127.     DEF >B  is the same as SUB >B <A ABC DEF. Also, any tools that 
  128.     have options, have the option -H. By saying TOOL -H, you will 
  129.     get, on the console, a summary of all the legal options.
  130.     
  131.     You cannot specify as the standard output a file on another disk. 
  132.      This is because a temp file is created on the current disk first 
  133.     and then renamed correctly at the end.  This does allow both 
  134.     standard input and standard output to be the same file name. If 
  135.     you use a +file to specify the standard output, you can abort the 
  136.     process if you see that the results are not as expected (easy to 
  137.     happen when using many metacharacters with SUB or SELECT).  A CTL 
  138.     C will kill the process without wiping out file.  Operations such 
  139.     as CLEAN <FILE >FILE  or SUB <FILE ABC DEF +FILE are ok and 
  140.     useful.
  141.     
  142.     The full power of these tools is shown when they are used within 
  143.     .SUB files with SUBMIT.  Once a sequence is worked out to to a 
  144.     particular task, it can be canned and put to general use by 
  145.     creating a .SUB file.
  146.     
  147.     The tools are partcularly useful in creating a .SUB file 
  148.     containing a string of commands to operate on a list of files. LS 
  149.     can create a list of file names, and SUB can transform them into 
  150.     a series of commands for each file in the list.  There is  an 
  151.     example in the page on SUB.
  152.